/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.groups.pools;

import com.flickr.api.FlickrServiceException;
import com.flickr.api.Paginated;
import com.flickr.api.groups.Group;
import com.flickr.api.photos.Photo;
import com.flickr.api.photos.PhotoContext;

/**
 *
 * @author Fabien Barbero
 */
public interface GroupsPoolsService {
    
    /**
     * Add a photo to a group's pool.
     * @param group                     The group.
     * @param photo                     The photo to add.
     * @throws FlickrServiceException   Error adding the photo.
     */
    void addPhoto(Group group, Photo photo) throws FlickrServiceException;
    
    /**
     * Remove a photo from a group pool.
     * @param group                     The group.
     * @param photo                     The photo to remove.
     * @throws FlickrServiceException   Error removing the photo.
     */
    void removePhoto(Group group, Photo photo) throws FlickrServiceException;
    
    /**
     * Returns next and previous photos for a photo in a group pool.
     * @param group                     The group.
     * @param photo                     The photo.
     * @return                          The context of the photo.
     * @throws FlickrServiceException   Error getting the context.
     */
    PhotoContext getContext(Group group, Photo photo) throws FlickrServiceException;
    
    /**
     * Returns a list of groups to which you can add photos.
     * @param perPage                   The number of groups per page.
     * @param page                      The page index.
     * @return                          The groups.
     * @throws FlickrServiceException   Error getting the groups.
     */
    Paginated<Group> getGroups(int perPage, int page) throws FlickrServiceException;
    
    /**
     * Returns a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).
     * @param group                     The group.
     * @param perPage                   The number of photos per page.
     * @param page                      The page index.
     * @return                          The photos.
     * @throws FlickrServiceException   Error getting the photos.
     */
    Paginated<Photo> getPhotos(Group group, int perPage, int page) throws FlickrServiceException;
    
}
